Carbon


FSRenameUnicode

Header: Files.h Carbon status: Supported

Renames a file or folder.

OSErr FSRenameUnicode (
    const FSRef *ref, 
    UniCharCount nameLength, 
    const UniChar *name, 
    TextEncoding textEncodingHint, 
    FSRef *newRef
);
ref

A pointer to the file or directory to be renamed.

nameLength

The length of the new name in Unicode characters.

name

A pointer to the new Unicode name of the specified file or directory.

textEncodingHint

A suggested text encoding to use for the name; pass kTextEncodingUnknown to use a default value.

newRef

On return, a pointer to the new FSRef for the file or directory. This parameter is optional and you may set it to NULL.

function result

A result code.

AVAILABILITY

Supported in Carbon. Available in Mac OS 9, and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)